Merge all Encore installation articles into a single one #10815
Conversation
|
I’m fine with this. I split it originally to try to avoid confusion - I made the “Flex” install path the default one - and you would need to dig further to see the non-Flex instructions. With this, the non-Flex instructions are now right in front, and (in theory) Flex users may just keep reading and try run those commands as well. Both seem equally perfect/imperfect to me. |
|
I see. Also, as reported in #10818 there aren't two installation guides but three:
I wanted to create just a single resource to encourage the usage of Encore outside of Symfony/PHP (I used it in a Go app and it worked like a charm). I don't want to bury/hide/discourage the installation and usage of Encore outside Symfony apps. Encore is amazing and everybody should know about it. |
|
Hmm, there should be only 2, because if you’re using Symfony, we must assume you’re using Flex. So Flex+Symfony and then “not Symfony”. I can see how it’s currently unclear for the minority of Symfony, non-Flex users. So let’s go with your way |
frontend/encore/installation.rst
Outdated
| This will create a ``webpack.config.js`` file, add the ``assets/`` directory, and | ||
| add ``node_modules/`` to ``.gitignore``. | ||
| This will create a ``webpack.config.js`` file, add the ``assets/`` directory, | ||
| and add ``node_modules/`` to ``.gitignore``. |
There was a problem hiding this comment.
Let’s mention here that this also installed a bundle that you’ll need - it may help non-Flex users to know what’s going on.
|
|
||
| .. tip:: | ||
| First, make sure you `install Node.js`_ and also the `Yarn package manager`_. | ||
| The following instructions depend on whether you are installing Encore in a |
There was a problem hiding this comment.
I’m cool with this - a bit awkward - but can’t think of anything much better
frontend/encore/installation.rst
Outdated
|
|
||
| First, make sure you `install Node.js`_ and also the `Yarn package manager`_. Then | ||
| run: | ||
| In your application is using :doc:`Symfony Flex </setup/flex>`, run the |
… (javiereguiluz) This PR was squashed before being merged into the 3.4 branch (closes #10815). Discussion ---------- Merge all Encore installation articles into a single one @weaverryan it's OK if you disagree with this and we can close this in that case. However, I dislike the current split installation articles because they create an artificial fragmentation and confuses readers. A single entry point to install Encore seems more useful, specially because the "Symfony Flex Installation" is tiny, so the entire article is not too long. Having said this, I don't like the last phrase of the introduction, so it needs some reword: ``` The following instructions depend on whether you are installing Encore in a Symfony application or not. ``` Commits ------- 4ef3922 Merge all Encore installation articles into a single one
…gle one (javiereguiluz) This PR was squashed before being merged into the 3.4 branch (closes symfony#10815). Discussion ---------- Merge all Encore installation articles into a single one @weaverryan it's OK if you disagree with this and we can close this in that case. However, I dislike the current split installation articles because they create an artificial fragmentation and confuses readers. A single entry point to install Encore seems more useful, specially because the "Symfony Flex Installation" is tiny, so the entire article is not too long. Having said this, I don't like the last phrase of the introduction, so it needs some reword: ``` The following instructions depend on whether you are installing Encore in a Symfony application or not. ``` Commits ------- 4ef3922 Merge all Encore installation articles into a single one
@weaverryan it's OK if you disagree with this and we can close this in that case.
However, I dislike the current split installation articles because they create an artificial fragmentation and confuses readers. A single entry point to install Encore seems more useful, specially because the "Symfony Flex Installation" is tiny, so the entire article is not too long.
Having said this, I don't like the last phrase of the introduction, so it needs some reword: